docs(admin-cli): document run-db-migration --skip-extension-reconcile and --embedding-dimension#2327
Open
r266-tech wants to merge 1 commit into
Open
Conversation
… and --embedding-dimension The run-db-migration Options table listed only `--schema`, but the command also exposes two operator-facing flags (hindsight_api/admin/cli.py): - `--embedding-dimension` — enforce an expected embedding dimension after migrations (omit to skip the dimension sync). - `--skip-extension-reconcile` — added in vectorize-io#2309; skip the post-migration vector/text-search index reconcile to speed up no-change re-migrations across many tenant schemas when the backend is unchanged. Add both rows to the canonical Options table and regenerate the docs skill mirror.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
run-db-migrationOptions table indeveloper/admin-cli.mdlists only--schema, buthindsight-api-slim/hindsight_api/admin/cli.pyexposes two more operator-facing flags:--embedding-dimension— enforce an expected embedding dimension after migrations (omit to skip the dimension sync).--skip-extension-reconcile— added in perf(migrations): skippable extension reconcile + drop unused global vector index #2309; skip the post-migration vector/text-search index reconcile to speed up no-change re-migrations across many tenant schemas when the backend is unchanged.Operators running migrations manually (CI/CD, large multi-tenant deployments) can't discover these from the docs today.
Fix
Add both rows to the existing Options table on the canonical source doc and regenerate the docs skill mirror:
hindsight-docs/docs/developer/admin-cli.mdskills/hindsight-docs/references/developer/admin-cli.md— regenerated via./scripts/generate-docs-skill.shDescriptions are taken from the flags'
typer.Optionhelp text. Pure docs, no behavior change.